<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"> <style>
	.KEYW {color: #933;}
	.COMM {color: #bbb; font-style: italic;}
	.NUMB {color: #393;}
	.STRN {color: #393;}
	.REGX {color: #339;}
	.line {border-right: 1px dotted #666; color: #666; font-style: normal;}
	</style></head><body><pre><span class='line'>  1</span> <span class="COMM">/**
<span class='line'>  2</span>  * Work with exchanges.
<span class='line'>  3</span>  *
<span class='line'>  4</span>  * Exchanges match and distribute messages across queues.  Exchanges can be
<span class='line'>  5</span>  *   configured in the server or created at runtime.
<span class='line'>  6</span>  *
<span class='line'>  7</span>  * @name Exchange
<span class='line'>  8</span>  * @exports Exchange as api.Exchange
<span class='line'>  9</span>  * @class
<span class='line'> 10</span>  */</span><span class="WHIT">
<span class='line'> 11</span> 
<span class='line'> 12</span> 
<span class='line'> 13</span> </span><span class="COMM">/**
<span class='line'> 14</span>  * Confirms an exchange declaration.
<span class='line'> 15</span>  *
<span class='line'> 16</span>  * This method confirms a Declare method and confirms the name of the
<span class='line'> 17</span>  *     exchange, essential for automatically-named exchanges.
<span class='line'> 18</span>  *
<span class='line'> 19</span>  * @name Exchange#declareOk
<span class='line'> 20</span>  * @event
<span class='line'> 21</span>  * 
<span class='line'> 22</span>  */</span><span class="WHIT">
<span class='line'> 23</span> 
<span class='line'> 24</span> </span><span class="COMM">/**
<span class='line'> 25</span>  * Confirm deletion of an exchange.
<span class='line'> 26</span>  *
<span class='line'> 27</span>  * This method confirms the deletion of an exchange.
<span class='line'> 28</span>  *
<span class='line'> 29</span>  * @name Exchange#deleteOk
<span class='line'> 30</span>  * @event
<span class='line'> 31</span>  * 
<span class='line'> 32</span>  */</span><span class="WHIT">
<span class='line'> 33</span> 
<span class='line'> 34</span> 
<span class='line'> 35</span> 
<span class='line'> 36</span> </span><span class="COMM">/**
<span class='line'> 37</span>  * Declare exchange, create if needed.
<span class='line'> 38</span>  *
<span class='line'> 39</span>  * This method creates an exchange if it does not already exist, and if the
<span class='line'> 40</span>  *     exchange exists, verifies that it is of the correct and expected class.
<span class='line'> 41</span>  *
<span class='line'> 42</span>  * @name Exchange#declare
<span class='line'> 43</span>  * @function
<span class='line'> 44</span>  * @param {Number} ticket An access ticket granted by the server for a certain set of access
<span class='line'> 45</span>  *     rights within a specific realm. Access tickets are valid within the
<span class='line'> 46</span>  *     channel where they were created, and expire when the channel closes.
<span class='line'> 47</span>  * @param {String} exchange The exchange name is a client-selected string that identifies
<span class='line'> 48</span>  *       the exchange for publish methods.  Exchange names may consist
<span class='line'> 49</span>  *       of any mixture of digits, letters, and underscores.  Exchange
<span class='line'> 50</span>  *       names are scoped by the virtual host.
<span class='line'> 51</span>  * @param {String} type Each exchange belongs to one of a set of exchange types implemented
<span class='line'> 52</span>  *       by the server.  The exchange types define the functionality of the
<span class='line'> 53</span>  *       exchange - i.e. how messages are routed through it.  It is not valid
<span class='line'> 54</span>  *       or meaningful to attempt to change the type of an existing exchange.
<span class='line'> 55</span>  * @param {Boolean} passive If set, the server will not create the exchange.  The client can use
<span class='line'> 56</span>  *     this to check whether an exchange exists without modifying the server
<span class='line'> 57</span>  *     state.
<span class='line'> 58</span>  * @param {Boolean} durable If set when creating a new exchange, the exchange will be marked as
<span class='line'> 59</span>  *       durable.  Durable exchanges remain active when a server restarts.
<span class='line'> 60</span>  *       Non-durable exchanges (transient exchanges) are purged if/when a
<span class='line'> 61</span>  *       server restarts.
<span class='line'> 62</span>  * @param {Boolean} autoDelete If set, the exchange is deleted when all queues have finished
<span class='line'> 63</span>  *       using it.
<span class='line'> 64</span>  * @param {Boolean} internal If set, the exchange may not be used directly by publishers, but
<span class='line'> 65</span>  *       only when bound to other exchanges. Internal exchanges are used to
<span class='line'> 66</span>  *       construct wiring that is not visible to applications.
<span class='line'> 67</span>  * @param {Boolean} nowait If set, the server will not respond to the method. The client should
<span class='line'> 68</span>  *     not wait for a reply method.  If the server could not complete the
<span class='line'> 69</span>  *     method it will raise a channel or connection exception.
<span class='line'> 70</span>  * @param {Object} arguments A set of arguments for the declaration. The syntax and semantics
<span class='line'> 71</span>  *       of these arguments depends on the server implementation.  This
<span class='line'> 72</span>  *       field is ignored if passive is 1.
<span class='line'> 73</span>  */</span><span class="WHIT">
<span class='line'> 74</span> 
<span class='line'> 75</span> </span><span class="COMM">/**
<span class='line'> 76</span>  * Delete an exchange.
<span class='line'> 77</span>  *
<span class='line'> 78</span>  * This method deletes an exchange.  When an exchange is deleted all queue
<span class='line'> 79</span>  *     bindings on the exchange are cancelled.
<span class='line'> 80</span>  *
<span class='line'> 81</span>  * @name Exchange#delete
<span class='line'> 82</span>  * @function
<span class='line'> 83</span>  * @param {Number} ticket An access ticket granted by the server for a certain set of access
<span class='line'> 84</span>  *     rights within a specific realm. Access tickets are valid within the
<span class='line'> 85</span>  *     channel where they were created, and expire when the channel closes.
<span class='line'> 86</span>  * @param {String} exchange The exchange name is a client-selected string that identifies
<span class='line'> 87</span>  *       the exchange for publish methods.  Exchange names may consist
<span class='line'> 88</span>  *       of any mixture of digits, letters, and underscores.  Exchange
<span class='line'> 89</span>  *       names are scoped by the virtual host.
<span class='line'> 90</span>  * @param {Boolean} ifUnused If set, the server will only delete the exchange if it has no queue
<span class='line'> 91</span>  *       bindings. If the exchange has queue bindings the server does not
<span class='line'> 92</span>  *       delete it but raises a channel exception instead.
<span class='line'> 93</span>  * @param {Boolean} nowait If set, the server will not respond to the method. The client should
<span class='line'> 94</span>  *     not wait for a reply method.  If the server could not complete the
<span class='line'> 95</span>  *     method it will raise a channel or connection exception.
<span class='line'> 96</span>  */</span><span class="WHIT">
<span class='line'> 97</span> 
<span class='line'> 98</span> </span></pre></body></html>